Primitive Class Vec2
Represents a float-based 2D vector.
Members
| x | (float) X component. |
| y | (float) Y component. |
Functions
| Vec2(x, y) | Create a Vec2 object. |
| Vec(value) | Create a Vec2 object. |
| Vec2:Normalize() | Get a copy of this Vec2 normalized to length 1. |
| Vec2:Translate(dir, dist) | Get a copy of this Vec2 translated in the input Vec2 direction by the input distance. |
| Vec2:Translate(rot, dist) | Get a copy of this Vec2 translated in the direction of the input rotation in degrees by the input distance. |
| Vec2:Translate(rot, relOffset) | Get a copy of this Vec2 translated by an offset, where the input relative offset Vec2 is rotated according to the input rotation in degrees. |
| Vec2:Rotate(rot) | Get a copy of this Vec2 rotated by the input rotation in degrees. |
| Vec2:Lerp(vector, alpha) | Get the linearly interpolated Vec2 between this Vec2 and the input Vec2 according to the input interpolation alpha. |
| Vec2:Cross(vector) | Get the cross product of this Vec2 and the input Vec2. |
| Vec2:Dot(vector) | Get the dot product of this Vec2 and the input Vec2. |
| Vec2:Distance(vector) | Get the distance between this Vec2 and the input Vec2. |
| Vec2:Length() | Get the length of this Vec2. |
| __tostring(This) | Metafunction. |
Members
Functions
- Vec2(x, y)
-
Create a Vec2 object.
Parameters:
- x float X component.
- y float Y component.
Returns:
-
Vec2
A new Vec2 object.
- Vec(value)
-
Create a Vec2 object.
Parameters:
- value float X and Z component.
Returns:
-
Vec2
A new Vec2 object.
- Vec2:Normalize()
-
Get a copy of this Vec2 normalized to length 1.
Returns:
-
Vec2
Normalized vector.
- Vec2:Translate(dir, dist)
-
Get a copy of this Vec2 translated in the input Vec2 direction by the input distance.
Parameters:
- dir Vec2 Direction vector. Normalized automatically to length 1.
- dist float Distance.
Returns:
-
Vec2
Translated vector.
- Vec2:Translate(rot, dist)
-
Get a copy of this Vec2 translated in the direction of the input rotation in degrees by the input distance.
Parameters:
- rot Rotation Rotation in degrees defining the direction.
- dist float Distance.
Returns:
-
Vec2
Translated vector.
- Vec2:Translate(rot, relOffset)
-
Get a copy of this Vec2 translated by an offset, where the input relative offset Vec2 is rotated according to the input rotation in degrees.
Parameters:
- rot float Rotation in degrees rotating the input relative offset vector.
- relOffset Vec2 Relative offset vector before rotation.
Returns:
-
Vec2
Translated vector.
- Vec2:Rotate(rot)
-
Get a copy of this Vec2 rotated by the input rotation in degrees.
Parameters:
- rot float Rotation in degrees.
Returns:
-
Vec2
Rotated Vec2.
- Vec2:Lerp(vector, alpha)
-
Get the linearly interpolated Vec2 between this Vec2 and the input Vec2 according to the input interpolation alpha.
Parameters:
- vector Vec2 Interpolation target.
- alpha float Interpolation alpha in the range [0, 1].
Returns:
-
Vec2
Linearly interpolated vector.
- Vec2:Cross(vector)
-
Get the cross product of this Vec2 and the input Vec2.
Parameters:
- vector Vec2 Input vector.
Returns:
-
Vec2
Cross product.
- Vec2:Dot(vector)
-
Get the dot product of this Vec2 and the input Vec2.
Parameters:
- vector Vec2 Input vector.
Returns:
-
float
Dot product.
- Vec2:Distance(vector)
-
Get the distance between this Vec2 and the input Vec2.
Parameters:
- vector Vec2 Input vector.
Returns:
-
float
Distance.
- Vec2:Length()
-
Get the length of this Vec2.
Returns:
-
float
Length.
- __tostring(This)
-
Metafunction. Use tostring(vector).
Parameters:
- This Vec2 Vec2.
Returns:
-
string
A string showing the X and Y components of the Vec2.